/*
 * Copyright 2023 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package androidx.paging

/**
 * Interface for a factory that generates [PagingSource].
 *
 * The factory extending this interface can be used to instantiate a [Pager] as the
 * pagingSourceFactory.
 */
public fun interface PagingSourceFactory<Key : Any, Value : Any> : () -> PagingSource<Key, Value> {
    /**
     * Returns a new PagingSource instance.
     *
     * This function can be invoked by calling pagingSourceFactory() or pagingSourceFactory::invoke.
     */
    public override operator fun invoke(): PagingSource<Key, Value>
}
